home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / clear2.arc / CLEARCUT.TXT < prev   
Text File  |  1980-01-01  |  7KB  |  158 lines
  1.                            ClearCut 1.2
  2.                                  
  3.                 A Text File Clarification Program
  4.                                 by
  5.                      Imagination Enterprises
  6.                                  
  7.                            Mark Lefler
  8.                            28 June 1987
  9.  
  10.  
  11.     ClearCut is a program that can improve the clarity of your
  12. writing.  ClearCut quickly looks for bad, overblown or confusing
  13. words, and suggests replacements for these words. ClearCut is
  14. very good at getting rid of "governmentese" that may have snuck
  15. into your writing.  The new version of ClearCut (1.2) can search
  16. for phrases, and suggest replacements as well.  Also, more
  17. information about your writing is displayed, including a rating
  18. on the clarity of your writing.
  19.     When you use ClearCut, the program will examine your text
  20. file, and suggest changes.  Your file will be copied and these
  21. changes added to the new file.  Words and phrases that the
  22. program finds confusing, unclear, or overblown are marked with a
  23. >>, and suggested changes added after the word or phrase.  For
  24. instance, if the program finds the word "examine", it may suggest
  25. that the word "look" might be more clear, like this:
  26.  
  27.                         >examine>>look<<
  28.  
  29.     After running the program, using your word processor you can
  30. edit the new file and search for >>.  You can then make the
  31. suggested change, or delete the suggestion.
  32.     The output from the program can go to a new text file, the
  33. screen, or both.  The changes can be displayed on the screen or
  34. the text file or both.
  35.     After the program has examined the file, it will give you
  36. information about how many words there are in your file.  It also
  37. gives an average length of words.  Shorter words are generally
  38. clearer.  Finally the program will give you a Readibility Index,
  39. telling you how clear your writing is.  ClearCut 1.2 even will
  40. make suggestions on ways to improve your writing.
  41.  
  42.  
  43. USING THE PROGRAM
  44.  
  45.     ClearCut should only be used on ASCII text files.  Check
  46. your word processor manual to make sure your files are in ASCII
  47. format.  This may involve a simple conversion utility in your
  48. word processor (Multi-Mate for instance) or your word processor
  49. may be able to directly write text files (Framework and
  50. WordStar).  To use ClearCut, make sure the CLEARCUT.COM file, the
  51. BADWORDS.TXT file and your text file are on the current disk,
  52. then type:
  53.  
  54.                         CLEARCUT <Return>
  55.  
  56. Then just follow the simple instructions.  You will be asked to
  57. give a file name for the source of the information you want
  58. checked.  Just type in the name, then press <Return>.  Next you
  59. will be asked for the name for the file with the suggested
  60. changes marked.  If you do not want this marked file created,
  61. then just type:
  62.  
  63.         none <Return>
  64.  
  65.     Finally, you will be asked what information you would like
  66. ClearCut to display on the screen while it runs.  If you want No
  67. information displayed, then type the letter "n".  If you only
  68. want the recommended Suggested Changes displayed, then type "s". 
  69. If you want the entire File displayed, including the suggested
  70. changes, then type "f".
  71.     The program will search the file, and display the requested
  72. information.  When the searches are completed, you will be asked
  73. to hit any key to continue.  The next screen will give you
  74. information about your file, such as the number of words of
  75. various lengths, the number of sentences, the average word and
  76. sentence lengths, the number of recommended substitutions made
  77. (if any) and a Readability Index from 1 to 100.  The higher the
  78. number, the more clear the writing.  If ClearCut thinks that your
  79. writing could be improved, it will ask if you want some
  80. suggestions to improve the writing.  Answer "y" for yes or "n"
  81. for no.
  82.     If you want, you can tell CLEARCUT the name of the file you
  83. want to have checked and the other information on a single line,
  84. like shown:
  85.  
  86.                    CLEARCUT SAMPLE.TXT none f <Return>
  87.  
  88. where SAMPLE.TXT is the file you want examined.  This example
  89. would not write an output file (none), but it would display the
  90. entire file on screen with the recommended changes (f).  You can
  91. use this file, CLEARCUT.TXT, as an example.
  92.  
  93.  
  94. CHANGING OR ADDING YOUR OWN BAD WORDS
  95.  
  96.     You can modify the file of "bad words" and replacements.
  97. This file is called BADWORDS.TXT.  The first entry is a "bad
  98. word", the second entry is the replacement for the "bad word".
  99. This pattern continues with other "bad words" and replacements
  100. for the rest of the file.  To add your own words or phrases using
  101. your favorite text processor program, just insert them at the end
  102. of the list, along with your suggested replacements.  Remember
  103. that BADWORDS.TXT must be an ASCII or text file.  Each "bad word"
  104. or phrase should appear on a line by itself.  Also, the 
  105. replacements should be on a single line, and must immediately
  106. follow the bad word.  It is convenient to use capitol letters for
  107. the "bad words" and small letters for the replacements.  The next
  108. time ClearCut is run, the list will be resorted, and the file
  109. rewritten.  When the file is rewritten, the "bad words" will
  110. appear in capital letters.  This will make the file BADWORDS.TXT
  111. easier to read.
  112.     You can have up to 800 "bad word" lines and 800 suggested
  113. changes lines in the BADWORDS.TXT file.  Each line can be up to
  114. thirty characters long.  More than 30 characters in a line will
  115. be ignored.
  116.  
  117.  
  118. ABOUT THE PROGRAM
  119.  
  120.     ClearCut was written entirely in Borland's Turbo PASCAL. 
  121. The program uses very high speed search techniques to match your
  122. words and phrases to the words and phrases in the substitution
  123. file.  This same technique can be used in many special
  124. applications, such as computer language translation.  For
  125. instance, you could create a file that will help convert PASCAL
  126. programs to BASIC!  If you are interested in the code, a listing
  127. of the source is available for a small fee.  See below for
  128. mailing instructions.
  129.  
  130.  
  131. FINALLY
  132.     
  133.     Imagination Enterprises is a small business which creates
  134. useful programs for low prices.  Using the same technology used
  135. in ClearCut, a flexible language translation program has been
  136. developed.  The program uses a substitution file to translate
  137. SPANISH into ENGLISH (with a present vocabulary of 1300 Spanish
  138. words).  The translation program TRANS 1.0 is smart enough to
  139. prompt the user for any word that it doesn't know.  It will then
  140. remember the new translation the next time the program is run. 
  141. You can easily create your own vocabularies for other languages,
  142. and as a side benefit, once you have taught the program the
  143. English equivalent of Spanish words, you can create an English to
  144. Spanish translation file automatically!
  145.     If you want more information about Imagination Enterprises
  146. programs, send a self-addressed, stamped envelope to the address
  147. below.
  148.      If you find ClearCut useful, then send a suggested $5
  149. contribution to:
  150.  
  151.                       IMAGINATION ENTERPRISES
  152.                           223 Arbor Lane
  153.                       Bryans Road, MD  20616
  154.  
  155. Make sure you include your present address, so that information
  156. on updates to ClearCut can be sent to you.  Questions and
  157. comments may be sent to the same address.
  158.